home *** CD-ROM | disk | FTP | other *** search
/ 17 Bit Software 6: Level 6 / 17 Bit - Level 6 (1998)(Epic Marketing)[!].iso / quartz / q0970.dms / q0970.adf / readme.doc < prev    next >
Text File  |  1992-09-02  |  13KB  |  351 lines
  1. FESBasic/Readme.doc
  2.  
  3. CONTENTS
  4. ========
  5.  
  6.     1.  Introduction
  7.     2.  System Requirements
  8.     3.  The Editor
  9.     4.  Acknowledgments
  10.  
  11.  
  12. *****************************************************************************
  13. =============================================================================
  14.                                 1.INTRODUCTION
  15. =============================================================================
  16. *****************************************************************************
  17.  
  18. What is FES BASIC?
  19.  
  20. FES Basic is an implementation of the BASIC programming language on the
  21. Amiga Personal Computer. It's Features include:-
  22.  
  23.     *   Fully integrated environment: Programs can be run from the editor.
  24.  
  25.     *   "Intelligent" editor: your programs are automatically indented,
  26.         reserved words made into upper case, and some syntax checks are made
  27.         as you type the programs.
  28.  
  29.     *   Fast execution, FES basic out performs several every interpreter that
  30.         I have managed to test and even a (commercial) compiler.
  31.  
  32.     *   On line help. When typing a program pressing HELP gives a description
  33.         of the command by the cursor, usually including a brief example.
  34.  
  35.     *   No Line Numbers
  36.  
  37.     *   Rich selection of control constructs:-
  38.         FOR...NEXT
  39.         REPEAT...UNTIL
  40.         WHILE...WEND
  41.         DO...EXIT...LOOP
  42.         Block IFs
  43.         SELECT...CASE
  44.         PROCedures
  45.  
  46.     *   Support for AGA chipset. Yup this is probably the first basic with
  47.         16 million colours.
  48.  
  49.     *   100% Assembler code for run-time interpreter.
  50.  
  51.     *   Small Code, Interpreter only 36K bytes.
  52.  
  53.     *   Cheap. You should not have had to pay for this version. Registering
  54.         for updates is only £15.
  55.  
  56.  
  57.  
  58.  
  59. ***************************************************************************
  60. ===========================================================================
  61.                                 2.INSTALLATION
  62. ===========================================================================
  63. ***************************************************************************
  64.  
  65. First the BICL {BIT IN CAPITAL LETTERS} that all .doc files seem to contain:
  66.  
  67.      THIS PROGRAM IS COPYRIGHT  (C)  1992/93 FALCON  ENTERPRISE SYSTEMS.
  68.      IT MAY BE DISTRIBUTED PROVIDED THAT:-
  69.  
  70.    * ALL FILES ARE INCLUDED IN THE DISTRIBUTION. THIS INCLUDES THE
  71.      EDITOR, THE INTERPRETER, THE HELP FILE, ALL DEMONSTRATION FILES AND
  72.      THIS DOCUMENT.
  73.  
  74.    * NO FILES MAY BE MODIFIED IN ANY WAY. THE ONLY EXCEPTION TO THIS
  75.      IS THE COMPLETE PACKAGE MAY BE "PACKED" USING A READILY OBTAINABLE
  76.      ARCHIVER TO EASE DISTRIBUTION.
  77.  
  78.    * NO FEE OTHER THAN A REASONABLE COPYING FEE IS CHARGED.
  79.  
  80.    * THE PACKAGE MAY NOT BE INCLUDED ON A MAGAZINE COVERDISK WITHOUT
  81.      MY PERMISSION.
  82.  
  83. DISCLAIMER:
  84.  
  85. ALL RISKS INVOLVED IN USING THIS PACKAGE ARE ASSUMED BY THE USER. FES CANNOT
  86. BE HELD RESPONSIBLE FOR ANY DAMAGE OR LOSS CAUSED BY THE USE OF THIS PACKAGE,
  87. WHETHER DIRECT, INDIRECT OR COINCIDENTAL.
  88.  
  89. EFFORT HAS BEEN MADE TO ENSURE THAT THE DOCUMENTATION IS FULL AND ACCURATE
  90. BUT IN THE EVENT OF ANY ERRORS BEING PRESENT IN EITHER THE DOCUMENTATION OR
  91. THE PROGRAM THEN THE USER OF THE PROGRAM AGREES TO ACCEPT ALLRESPONSIBILITY
  92. FOR THESE FAILINGS.
  93.  
  94. PERMISSION IS GRANTED TO USE THIS PACKAGE IF, AND ONLY IF, THE USER AGREES IN
  95. FULL TO THE ABOVE TERMS.
  96.  
  97. IF DISCLAIMERS OF THE ABOVE FORM ARE NOT LEGAL IN THE PART OF THE WORLD
  98. WHERE YOU LIVE THEN YOU MAY NOT USE THIS PROGRAM UNTIL YOU TAKE WHATEVER
  99. ACTION IS REQUIRED IN YOUR STATE TO LEGALY ACTIVATE THIS DISCLAIMER.
  100.  
  101.  
  102. Sorry about all that, dear user, but I have to cover myself fully. This
  103. program has never done anything nasty to my system, but if due to some
  104. unforeseen circumstances it re-formats your boss's hard-disk then its
  105. your problem not mine. OK.
  106.  
  107.  
  108. SYSTEM REQUIREMENTS
  109. ===================
  110.  
  111. FES Basic requires an amiga with at least 512K of memory and Workbench
  112. version 1.3. It is recommended that it is used with 1MB of memory and
  113. Workbench 2.0+.
  114.  
  115. It is recommended that "reqtools.library" is in your LIBS: directory.
  116. Without it the program will work but many of the requesters will not
  117. appear, this makes editor functions like GOTO line rather useless.
  118.  
  119. The Menu strip is missing if the program is run using a 1.3 Amiga, this
  120. means that you will have to use keys like AMIGA+L to load, rather than
  121. having the option to use the mouse. Also on a 1.3 based machine reqtools
  122. as mentioned above is neccary.
  123.  
  124. INSTALLATION
  125. ============
  126.  
  127. FES Basic can be run from the CLI or from workbench. Under Workbench 1.3
  128. you will need to have reqtools.library in your LIBS: directory. There may
  129. be an 'install_library' script enclosed with this distribution to do this
  130. for you. Under WB 2.0 reqtools will be used if available, but if not then
  131. asl.library will be used instead.
  132.  
  133. RUNNING THE PROGRAM
  134. ===================
  135.  
  136. Either double click on the FES_Editor icon or 'CD' to the correct directory
  137. and type 'FES_Editor'. If everything is OK then an editor window should open.
  138. You can type programs into this window.
  139.  
  140.  
  141.  
  142. *****************************************************************************
  143. =============================================================================
  144.                             3 USING THE EDITOR
  145. =============================================================================
  146. *****************************************************************************
  147.  
  148. Once you have got the package running as described in part 2 above you are
  149. ready to start programming.
  150.  
  151.  
  152.  
  153. 3.1 EDITING
  154. ===========
  155.  
  156. Program editors are fairly standard things, so if you have used anysort of
  157. text editor you should find everything quite straightforward.
  158.  
  159. Text can be entered at the cursor by typing. The Cursor can be moved using
  160. the cursor keys. Pressing SHIFT with LEFT or RIGHT moves to the end of the
  161. line. SHIFT + UP or DOWN moves up or down by one page. ALT + UP or DOWN
  162. moves to either end of the program.
  163.  
  164. Whenever you try to move the cursor off a line that has been modified the
  165. computer will do a syntax check of the line. If any errors are found then a
  166. message will appear at the top of the screen and the computer will not allow
  167. you to move of the line until the error has been corrected.
  168.  
  169. Reserved words (like PRINT, LEN , AND) etc will be made into capital letters
  170. automatically for you. This allows you to easily see if you have mistakenly
  171. used a reserved word as a variable.
  172.  
  173. Statements (words like PRINT STOP SCREEN , that always come at the start of
  174. a line) can often be abbreviated. The computer will fill in the abbreviation
  175. when you try to leave a line. DO NOT PUT A DOT TO INDICATE AN ABBREVIATION as
  176. you would on a certain computer. You abbreviate PRINT to P  not to P.
  177.  
  178.  
  179. At the second and subsequent uses of a variable name the name will be
  180. converted to the same case as when it was first used. So if you firsttype
  181. 'Count' then later type 'count' or 'COUNT' then they will be changed to
  182. 'Count'. An exception is names with 1 or 2 characters are always lower
  183. case.
  184.  
  185. Multi line statements like FOR...NEXT loops or block IFs are automatically
  186. indented for you. You cannot change the amount of indentation on a line.
  187.  
  188. Text can be deleted using BACKSPACE or DEL. Backspace deletes the character
  189. to the left of the cursor, DEL deletes the character inside the cursor.
  190. Backspacing beyond the beginning of a line can be used to delete blank
  191. lines.
  192.  
  193. 3.2 DISK OPERATIONS
  194. ===================
  195.  
  196. Programs can be saved to disk by pressing AMIGA+S ( or use the menus if you
  197. have WB 2.0 or later). A file requester should appear. Choose the name and
  198. the file can be stored.
  199.  
  200. The editor can save files in 3 different formats :- ASCII , FES and
  201. Fes_Prot.
  202.  
  203. ASCII (American Standard Code for Information Interchange) format allows the
  204. programs to programs to be easily loaded into word-processors or other
  205. versions of basic etc,  but tends to be rather slower to load and save
  206. than FES format. Use AMIGA+A (or menu) to save a file in ASCII format.
  207.  
  208. FES format programs cannot be loaded into other programs. But they load
  209. faster and can be loaded directly by the stand-alone interpreter. This is
  210. the normal format for saving. Use AMIGA+S to save in this format. Use
  211. AMIGA+SHIFT+S to save with the same name as the file was loaded.
  212.  
  213. FES_Prot format is shorter than FES Format. It can ONLY be used with the
  214. stand-alone interpreter, a program saved in this format cannot be loaded back
  215. into the editor. Use this format when giving copies of your programs to
  216. other people when you don't want them to be able to see your listings. Make
  217. sure you always keep a copy of the program in a non FES_Prot format so
  218. you can make changes. This option is only available from the menus.
  219.  
  220. Programs can be loaded with AMIGA+L (or menu). The editor automatically
  221. detects which format the program is in when loading. Loading a FES_Prot file
  222. will crash the machine.
  223.  
  224. 3.3 RUNNING PROGRAMS
  225. ====================
  226.  
  227. Once a program has been entered or loaded it can be executed.
  228.  
  229. To start a program press AMIGA+X (or menu). There may be a burst of disk
  230. access while the interpreter is loaded. Then the screen should blank and the
  231. program should start executing.
  232.  
  233. Once the program has finished press any key to return to the editor.
  234.  
  235. If a program becomes faulty and needs to be stopped press CTRL+C.
  236.  
  237. Once a program has stopped you can examine the variable contents from the
  238. editor. Press AMIGA+V (or you guessed it the meun) and a list of all your
  239. int variables and their contents should appear. Press '2' for a list of
  240. longs or '3' for strings, any other key to return to the editor.
  241.  
  242. Pressing ESCape will take you into 'immediate' mode. The screen should
  243. switch to the programs screen and a ">" prompt appears. Type BASIC
  244. commands here and they will be executed immediately. This mode is usually
  245. used to see the contents of arrays or expressions.
  246.  
  247. Note there is a known bug in the immediate mode. If you type a literal string
  248. (eg PRINT "hello") then the string will often become corrupted. Sorry
  249. about that.
  250.  
  251.  
  252. 3.4 OTHER EDITOR FUNCTIONS
  253. ==========================
  254.  
  255. The current program can be cleared using AIMIA+Z (new in the menu)
  256.  
  257. The line containing the cursor can be cleared using CTRL+Y, the last
  258. deleted line can be pasted back using CTRL+U. These two commands can be used
  259. to swap the order of two lines,or to duplicate a line.
  260.  
  261. Any changes made to a line can be removed by pressing CTRL-Z.
  262.  
  263. The editor can be quitted with AMIGA+Q.
  264.  
  265. Simple analysis of the program can be performed using AMIGA+T. This
  266. checks for multiply defined labels/procedures/functions and mismatched
  267. control constructs (eg FOR without NEXT).
  268.  
  269. Blocks of text can be marked using F1 for start and F2 for end. Then
  270. press F3 to delete the block, F4 to copy a block and SHIFT+F4 to move the
  271. block.
  272.  
  273.  
  274. 3.5 SUMMARY OF EDITOR FUNCTIONS
  275. ===============================
  276.  
  277.       UP    Move up 1 line
  278. SHIFT UP    Move up 1 screen
  279. ALT   UP    Move to top of file
  280.     DOWN    Move down 1 line
  281. SHIFT DN    Move down 1 screen
  282. ALT DOWN    Move to bottom of file
  283.     LEFT    Move left 1 space
  284. SHIFT LT    Move to start of line
  285.    RIGHT    Move right 1 space
  286. SHFT RGT    Move to end of line
  287.  
  288. Esc         Goto Immediate mode
  289.  
  290. CTRL+Y      Delete current line
  291. CTRL+U      Undelete line
  292. CTRL+Z      Undo changes on line
  293.  
  294. F1          Mark Start of Block
  295. F2          Mark end of Block
  296. F3          Delete Block
  297. F4          Copy Block to cursor
  298. SHIFT F4    Move Block to cursor
  299.  
  300. AMIGA A     Save ASCII
  301. AMIGA F     Find Text...
  302. AMIGA G     Goto Line number...
  303. AMIGA I     Iconify Window
  304. AMIGA L     Load File
  305. AMIGA N     Find Next Text
  306. AMIGA Q     Quit editor
  307. AMIGA S     Save File
  308. SH+AM S     Save File with same name
  309. AMIGA T     Check Program for Errors.
  310. AMIGA V     View variables
  311. AMIGA X     eXecute program
  312. AMIGA Z     New program
  313.  
  314.  
  315. ****************************************************************************
  316. ============================================================================
  317.                         4.Acknolegements
  318. ============================================================================
  319. ****************************************************************************
  320.  
  321. This program was written using DEVPAC 3 on an Amiga A500 fitted with
  322. 3Mb of ram and a GVP 52Mb hard disk. The editor was written using DICE, a
  323. most excellent 'C' compiler.
  324.  
  325. I would like to thank:-
  326.  
  327.     * DAX of ASTRASOFT, for help with the lex'er and plenty of other
  328.         Invaluable suggestions.If you know anyone with an Atari ST
  329.         advise them to get hold of DESKTRACKER or MONOTRIS.
  330.  
  331.     * StepPJ for helping me with maths tutorials, and plenty of tea.
  332.  
  333.     * Shorne for being a miserable bugger.
  334.  
  335.     * Guy for letting me beat him at SuperCars II.
  336.  
  337.     * Oli for bug testing.
  338.  
  339.     * Paul from Saundersoft for many, many, phone calls.
  340.  
  341.     * Nico François for reqtools.library and many other excellent
  342.         contributions to the world of Amiga PD.
  343.  
  344.     * Mum and Dad.
  345.  
  346.  
  347. And finaly thank you for taking the time to read this waffle.
  348.  
  349.                                         =SDF=
  350.  
  351.